Node / meshtastic / Meshtastic-Android / files / docs / en / developer / testing.md

Displaying Rendered • View raw • Download

title: Testing

parent: Developer Guide

nav_order: 7

last_updated: 2026-06-11

aliases:

• tests

• unit-tests

• screenshot-tests

Testing strategy and practices for the Meshtastic KMP project.

Shared tests that run on all platforms:

T282828

• Business logic tests

• Data model validation

• Search/ranking algorithm tests

• Route serialization tests

Android-specific tests that run on JVM:

T282828

• ViewModel tests

• Repository tests with Room fakes

• Android-specific integration tests

Compose Multiplatform UI test framework:

T282828

Tff7b72fun Td2a8ffmyScreenTestTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runComposeUiTest Tb4b4b4{

Te6edf3setContent Tb4b4b4{ Te6edf3MyScreenTb4b4b4(Tb4b4b4) Tb4b4b4}

Te6edf3onNodeWithTextTb4b4b4(Ta5d6ff"Ta5d6ffExpectedTa5d6ff"Tb4b4b4)Tb4b4b4.Te6edf3assertIsDisplayedTb4b4b4(Tb4b4b4)

Tb4b4b4}

Located in T383838commonTest or T383838jvmTest source sets.

Uses Android Gradle Plugin's native (layoutlib) screenshot testing framework, split across two modules:

• T383838:screenshot-tests — the visual-regression gate. CI runs T383838validateDebugScreenshotTest on it; reframing one of these baselines is a real diff to review. Holds atomic, dual-purpose components.

• T383838:docs-screenshots — generate-only, not validated in CI. Holds doc-framed compositions whose framing is tuned for the docs site, so reframing a doc image never churns the regression gate.

T282828

./gradlew :screenshot-tests:validateDebugScreenshotTest T8b949e# compare against goldens (CI gate)

./gradlew :docs-screenshots:updateDebugScreenshotTest T8b949e# record doc-framed composition images

./gradlew :screenshot-tests:copyDocsScreenshots T8b949e# copy doc images from BOTH modules into docs/assets

Rendering is host-deterministic here (layoutlib): a local T383838update produces references byte-identical to CI, so locally-recorded goldens pass T383838validate. See T383838docs/assets/screenshots/README.md for which module a new screenshot belongs in.

The T383838:baselineprofile module (#5735) generates a Baseline Profile for T383838:androidApp, AOT-compiling the hot startup paths so ART doesn't pay the JIT cost on first launch. It targets the google flavor (the variant most users run).

The Macrobenchmark generator (T383838BaselineProfileGenerator) and the before/after benchmark (T383838StartupBenchmark) live in T383838baselineprofile/src/main/kotlin/org/meshtastic/baselineprofile/. Both run on a device/emulator:

T282828

./gradlew :androidApp:benchmarkGoogleReleaseBaselineProfile T8b949e# Quantify the cold-start win

The generated profile is merged into T383838androidApp/src/google/generated/baselineProfiles/ and packaged into release builds via T383838androidx.profileinstaller.

│ ⚠️ Warning: The journey currently covers cold start only (launch → first frame), because CI has

│ no paired radio. Post-connection screens (node list, map, message thread) are not yet

│ AOT-compiled; extend the journey once a fake transport or connected device is wired into the

│ harness.

T282828

• Write tests in T383838commonTest when possible (runs everywhere)

• Test business logic independently from UI

• Use fakes/stubs instead of mocks where practical

• Test edge cases: empty states, error states, boundary values

• Test deep link routing in T383838DeepLinkRouterTest

• Keep tests fast — no network, no disk I/O in unit tests

• Don't test framework behavior (Compose internals, Room queries)

• Don't create tests that depend on other feature modules

• Don't use T383838Thread.sleep — use coroutine test dispatchers

• Don't rely on test execution order

T282828

./gradlew allTests

T8b949e# Specific module

./gradlew :feature:docs:allTests

T8b949e# Code quality

./gradlew spotlessCheck detekt

T8b949e# Full verification

./gradlew spotlessCheck detekt kmpSmokeCompile Tffa657test allTests

Tests run automatically on:

• Pull request creation/update

• Push to T383838main

• Pre-release validation

CI runs on GitHub-hosted Ubuntu 24.04 runners (most jobs use the T383838ubuntu-24.04-arm ARM runners, a few use T383838ubuntu-24.04) with JDK 25 and Gradle caching.